docs/Migrating from baseflight.md

   1 # Migrating from baseflight
   2
   3 ## Procedure
   4
   5 **First ensure your main flight battery is disconnected or your props are off!**
   6
   7 Before flashing with cleanflight, dump your configs for each profile via the CLI and save to a text file.
   8
   9 ```
  10 profile 0
  11 dump
  12 profile 1
  13 dump
  14 profile 2
  15 dump
  16 ```
  17
  18 Then after flashing cleanflight paste the output from each dump command into the cli, switching profiles as you go.
  19
  20 You'll note that some commands are not recognised by cleanflight when you do this.  For the commands that are not recognised look
  21 up the new configuration options and choose appropriate values for the settings.  See below for a list of differences.
  22
  23 Once you've done this for the first profile, save the config.  Then verify your config is OK, e.g. features serial ports, etc.
  24 When you've verified the first profile is OK repeat for the other profiles.
  25
  26 It's also advisable to take screenshots of your AUX settings from baseflight configurator and then after re-applying the settings
  27 verify your aux config is correct - aux settings are not backwards compatible.
  28
  29 ## CLI command differences from baseflight
  30
  31 In general all CLI commands use underscore characters to separate words for consistency.  In baseflight the format of CLI commands is somewhat haphazard.
  32
  33 ### gps_baudrate
  34 reason: new serial port configuration.
  35
  36 See `serial` command.
  37
  38 ### gps_type
  39 reason: renamed to `gps_provider` for consistency
  40
  41 ### serialrx_type
  42 reason: renamed to `serialrx_provider` for consistency
  43
  44 ### rssi_aux_channel
  45 reason: renamed to `rssi_channel` for improved functionality
  46
  47 Cleanflight supports using any RX channel for rssi.  Baseflight only supports AUX1 to 4.
  48
  49 In Cleanflight a value of 0 disables the feature, a higher value indicates the channel number to read RSSI information from.
  50
  51 Example: to use RSSI on AUX1 in Cleanflight use `set rssi_channel = 5`, since 5 is the first AUX channel (this is equivalent to `set rssi_aux_channel = 1` in Baseflight).
  52
  53 ### failsafe_detect_threshold
  54 reason: improved functionality
  55
  56 See `rx_min_usec` and `rx_max_usec` in Failsafe documentation.
  57
  58 ### emfavoidance
  59 reason: renamed to `emf_avoidance` for consistency
  60
  61 ### yawrate
  62 reason: renamed to `yaw_rate` for consistency
  63
  64 ### yawdeadband
  65 reason: renamed to `yaw_deadband` for consistency
  66
  67 ### midrc
  68 reason: renamed to `mid_rc` for consistency
  69
  70 ### mincheck
  71 reason: renamed to `min_check` for consistency
  72
  73 ### maxcheck
  74 reason: renamed to `max_check` for consistency
  75
  76 ### minthrottle
  77 reason: renamed to `min_throttle` for consistency
  78
  79 ### maxthrottle
  80 reason: renamed to `max_throttle` for consistency
  81
  82 ### mincommand
  83 reason: renamed to `min_command` for consistency
  84
  85 ### deadband3d_low
  86 reason: renamed to `3d_deadband_low` for consistency
  87
  88 ### deadband3d_high
  89 reason: renamed to `3d_deadband_high` for consistency
  90
  91 ### deadband3d_throttle
  92 reason: renamed to `3d_deadband_throttle` for consistency
  93
  94 ### neutral3d
  95 reason: renamed to `3d_neutral` for consistency
  96
  97 ### alt_hold_throttle_neutral
  98 reason: renamed to `alt_hold_deadband` for consistency
  99
 100 ### gimbal_flags
 101 reason: seperation of features.
 102
 103 see `gimbal_mode` and `CHANNEL_FORWARDING` feature